From 3ad90d3df7daace45c67a9ab8eef1e5289e8fe38 Mon Sep 17 00:00:00 2001 From: "emellor@leeni.uk.xensource.com" Date: Wed, 23 Nov 2005 19:31:14 +0000 Subject: [PATCH] Added comment describing usage. Signed-off-by: Ewan Mellor --- tools/python/xen/xend/xenstore/xswatch.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/tools/python/xen/xend/xenstore/xswatch.py b/tools/python/xen/xend/xenstore/xswatch.py index 8b8bb2d087..e84fe83ba9 100644 --- a/tools/python/xen/xend/xenstore/xswatch.py +++ b/tools/python/xen/xend/xenstore/xswatch.py @@ -13,6 +13,18 @@ from xen.xend.XendLogging import log class xswatch: + ## + # Create a watch on the given path in the store. The watch will fire + # immediately, then subsequently each time the watched path is changed, + # until the watch is deregistered, either by the return value from the + # watch callback being False, or by an explicit call to unwatch. + # + # @param fn The function to be called when the watch fires. This function + # should take the path that has changed as its first argument, followed by + # the extra arguments given to this constructor, if any. It should return + # True if the watch is to remain registered, or False if it is to be + # deregistered. + # def __init__(self, path, fn, *args, **kwargs): self.path = path self.fn = fn -- 2.30.2